Package com.cisco.pt.ipc.system.impl
Class CepInstanceImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.CepInstanceImpl
- All Implemented Interfaces:
IPCObject,CepInstance
- Direct Known Subclasses:
ScriptModuleImpl
Information provided by the PKI file:
\class CepInstance
\brief CepInstance is the external process (ExApp and Script Module) that communicates with Packet Tracer through the IPC.
\example ipcManager().thisInstance()
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionCepInstanceImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionbooleanInformation provided by the PKI file:voidInformation provided by the PKI file:getCep()Information provided by the PKI file:getExclusivePublisherAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:voidremoveExclusivePublisherAt(int index) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
CepInstanceImpl
public CepInstanceImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getInstanceId
Information provided by the PKI file:
\brief Returns the UUID of this external process. \return uuid, the UUID of this external process.- Specified by:
getInstanceIdin interfaceCepInstance- Returns:
- UUID Returns a UUID
-
getCep
- Specified by:
getCepin interfaceCepInstance- Returns:
- Cep Returns a Cep
-
addExclusivePublisher
Information provided by the PKI file:
\brief Returns true if the exclusive publisher with the specified certificate was added successfully, otherwise false. \param pem, the PEM base64-encoded DER certificate string. \return bool, true if the exclusive publisher with the specified certificate was added successfully, otherwise false.- Specified by:
addExclusivePublisherin interfaceCepInstance- Parameters:
pem- Takes in a parameter of pem- Returns:
- boolean Returns a boolean
-
clearExclusivePublishers
public void clearExclusivePublishers()Information provided by the PKI file:
\brief Clears all exclusive publishers.- Specified by:
clearExclusivePublishersin interfaceCepInstance
-
removeExclusivePublisher
Information provided by the PKI file:
\brief Returns true if the exclusive publisher with the specified certificate was removed successfully, otherwise false. \param pem, the PEM base64-encoded DER certificate string. \return bool, true if the exclusive publisher with the specified certificate was removed successfully, otherwise false.- Specified by:
removeExclusivePublisherin interfaceCepInstance- Parameters:
pem- Takes in a parameter of pem- Returns:
- boolean Returns a boolean
-
removeExclusivePublisherAt
public void removeExclusivePublisherAt(int index) Information provided by the PKI file:
\brief Removes the exclusive publisher at the specified index. \param index, the index of the exclusive publisher.- Specified by:
removeExclusivePublisherAtin interfaceCepInstance- Parameters:
index- Takes in a parameter of index
-
getExclusivePublisherCount
public int getExclusivePublisherCount()Information provided by the PKI file:
\brief Returns the number of exclusive publishers. \return int, the number of exclusive publishers.- Specified by:
getExclusivePublisherCountin interfaceCepInstance- Returns:
- int Returns a int
-
getExclusivePublisherAt
Information provided by the PKI file:
\brief Returns the exclusive publisher at the specified index. \param index, the index of the exclusive publisher. \return string, the exclusive publisher at the specified index.- Specified by:
getExclusivePublisherAtin interfaceCepInstance- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
hasExclusivePublisher
Information provided by the PKI file:
\brief Returns true if the specified certificate is an exclusive publisher, otherwise false. \param pem, the PEM base64-encoded DER certificate string. \return bool, Returns true if the specified certificate is an exclusive publisher, otherwise false.- Specified by:
hasExclusivePublisherin interfaceCepInstance- Parameters:
pem- Takes in a parameter of pem- Returns:
- boolean Returns a boolean
-
getCommandLineArg
Information provided by the PKI file:
\brief Returns the command line argument for this external process (ExApp or Script Module) when launching PT. \return QString, the command line argument fort his external process- Specified by:
getCommandLineArgin interfaceCepInstance- Returns:
- String Returns a String
-